<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>clCreateFromD3D10Texture3DKHR</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="clCreateFromD3D10Texture3DKHR" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clCreateFromD3D10Texture3DKHR"></a>
        <h1>clCreateFromD3D10Texture3DKHR</h1>
        <p>Creates an OpenCL 3D image object from a subresource of a Direct3D 10 3D texture.</p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                <a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a>
                    <strong class="fsfunc">clCreateFromD3D10Texture3DKHR</strong>(</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="pagedisplay">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>ID3D10Texture3D <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*resource</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">UINT</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">subresource</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>
                    <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
                     <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*errcode_ret</var>
                <code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <code class="varname">context</code>
              </span>
            </dt>
            <dd>
              <p>
                    A valid OpenCL context created from a Direct3D 10 device.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">flags</code>
              </span>
            </dt>
            <dd>
              <p>
                  A bit-field that is used to specify usage information.  May be
                  <code class="constant">CL_MEM_READ_ONLY</code>, <code class="constant">CL_MEM_WRITE_ONLY</code>,
                  or <code class="constant">CL_MEM_READ_WRITE</code>. (See the table for
                  <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>
                  for more information.)
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">resource</code>
              </span>
            </dt>
            <dd>
              <p>
                    A pointer to the Direct3D 10 3D texture to share.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">subresource</code>
              </span>
            </dt>
            <dd>
              <p>
                    The subresource of <code class="varname">resource</code> to share.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">errcode_ret</code>
              </span>
            </dt>
            <dd>
              <p>
                    An appropriate error code. If <code class="varname">errcode_ret</code> is NULL, no error code is returned.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
          The width, height and depth of the returned OpenCL 3D image object are determined
          by the width, height and depth of subresource <code class="varname">subresource</code> of
          <code class="varname">resource</code>. The channel type and order of the returned OpenCL 3D
          image object is determined by the format of <code class="varname">resource</code> as shown
          below in the table of Direct3D 10 and corresponding OpenCL image formats.
        </p>
        <p>
          This call will increment the internal Direct3D reference count on
          <code class="varname">resource</code>. The internal Direct3D reference count on
          <code class="varname">resource</code> will be decremented when the OpenCL reference count on
          the returned OpenCL memory object drops to zero.
        </p>
        <p>
           Following is a list of Direct3D 10 and corresponding OpenCL image formats.
        </p>
        <div class="informaltable">
          <table border="1">
            <colgroup>
              <col align="left" class="col1" />
              <col align="left" class="col2" />
            </colgroup>
            <thead>
              <tr>
                <th align="left">DXGI format</th>
                <th align="left">CL image format (channel order, channel data type)</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32B32A32_FLOAT</td>
                <td align="left">CL_RGBA, CL_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32B32A32_UINT</td>
                <td align="left">CL_RGBA, CL_UNSIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32B32A32_SINT</td>
                <td align="left">CL_RGBA, CL_SIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16B16A16_FLOAT</td>
                <td align="left">CL_RGBA, CL_HALF_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16B16A16_UNORM</td>
                <td align="left">CL_RGBA, CL_UNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16B16A16_UINT</td>
                <td align="left">CL_RGBA, CL_UNSIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16B16A16_SNORM</td>
                <td align="left">CL_RGBA, CL_SNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16B16A16_SINT</td>
                <td align="left">CL_RGBA, CL_SIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8B8A8_UNORM</td>
                <td align="left">CL_BGRA, CL_UNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8B8A8_UNORM</td>
                <td align="left">CL_RGBA, CL_UNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8B8A8_UINT</td>
                <td align="left">CL_RGBA, CL_UNSIGNED_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8B8A8_SNORM</td>
                <td align="left">CL_RGBA, CL_SNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8B8A8_SINT</td>
                <td align="left">CL_RGBA, CL_SIGNED_INT8</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32_FLOAT</td>
                <td align="left">CL_RG, CL_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32_UINT</td>
                <td align="left">CL_RG, CL_UNSIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32G32_SINT</td>
                <td align="left">CL_RG, CL_SIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16_FLOAT</td>
                <td align="left">CL_RG, CL_HALF_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16_UNORM</td>
                <td align="left">CL_RG, CL_UNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16_UINT</td>
                <td align="left">CL_RG, CL_UNSIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16_SNORM</td>
                <td align="left">CL_RG, CL_SNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16G16_SINT</td>
                <td align="left">CL_RG, CL_SIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8_UNORM</td>
                <td align="left">CL_RG, CL_UNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8_UINT</td>
                <td align="left">CL_RG, CL_UNSIGNED_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8_SNORM</td>
                <td align="left">CL_RG, CL_SNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8G8_SINT</td>
                <td align="left">CL_RG, CL_SIGNED_INT8</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32_FLOAT</td>
                <td align="left">CL_R, CL_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32_UINT</td>
                <td align="left">CL_R, CL_UNSIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R32_SINT</td>
                <td align="left">CL_R, CL_SIGNED_INT32</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16_FLOAT</td>
                <td align="left">CL_R, CL_HALF_FLOAT</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16_UNORM</td>
                <td align="left">CL_R, CL_UNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16_UINT</td>
                <td align="left">CL_R, CL_UNSIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16_SNORM</td>
                <td align="left">CL_R, CL_SNORM_INT16</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R16_SINT</td>
                <td align="left">CL_R, CL_SIGNED_INT16</td>
              </tr>
              <tr>
                <td align="left"> </td>
                <td align="left"> </td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8_UNORM</td>
                <td align="left">CL_R, CL_UNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8_UINT</td>
                <td align="left">CL_R, CL_UNSIGNED_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8_SNORM</td>
                <td align="left">CL_R, CL_SNORM_INT8</td>
              </tr>
              <tr>
                <td align="left">DXGI_FORMAT_R8_SINT</td>
                <td align="left">CL_R, CL_SIGNED_INT8</td>
              </tr>
            </tbody>
          </table>
        </div>
        <p>
      General information about sharing memory objects with Direct3D 10 follows.
    </p>
        <p>
        The goal of this extension is to provide interoperability between
        OpenCL and Direct3D 10. This is designed to function analogously
        to the <a class="citerefentry" href="cl_khr_gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">OpenGL
        interoperability</span></span></a> as defined in sections 9.7 and 9.8. If
        this extension is supported by an implementation, the string "cl_khr_d3d10_sharing"
        will be present in the <code class="constant">CL_PLATFORM_EXTENSIONS</code>
        (see <a class="citerefentry" href="clGetPlatformInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetPlatformInfo</span></span></a>)
        or <code class="constant">CL_DEVICE_EXTENSIONS</code> 
        (see <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>).
    </p>
        <p>
        As currently proposed the interfaces for this extension would be provided in
        <code class="code">cl_d3d10.h</code>.
    </p>
        <p>
        
        The OpenCL functions enabled by the <code class="function">cl_khr_d3d10_sharing</code> extension
        allow applications to use Direct3D 10 resources as OpenCL memory objects. This allows
        efficient sharing of data between OpenCL and Direct3D 10. The OpenCL API may be used
        to execute kernels that read and/or write memory objects that are also Direct3D 10
        resources. An OpenCL image object may be created from a Direct3D 10 texture resource. An
        OpenCL buffer object may be created from a Direct3D 10 buffer resource. OpenCL memory
        objects may be created from Direct3D 10 objects if and only if the OpenCL context
        has been created from a Direct3D 10 device.
    </p>
        <h4><a id="id-1.6.10"></a>Lifetime of Shared [D3D10] Objects</h4>
        <p>
        An OpenCL memory object created from a Direct3D 10 resource remains valid as long as the 
        corresponding Direct3D 10 resource has not been deleted. If the Direct3D 10 resource is deleted 
        through the Direct3D 10 API, subsequent use of the OpenCL memory object will result in 
        undefined behavior, including but not limited to possible OpenCL errors, data corruption, and 
        program termination.
    </p>
        <p>
        The successful creation of a cl_context against a Direct3D 10 device specified via the context 
        create parameter <code class="constant">CL_CONTEXT_D3D10_DEVICE_KHR</code> will increment the internal Direct3D 
        reference count on the specified Direct3D 10 device. The internal Direct3D reference count on 
        that Direct3D 10 device will be decremented when the OpenCL reference count on the returned 
        OpenCL context drops to zero.
    </p>
        <p>
        The OpenCL context and corresponding command-queues are dependent on the existence of the 
        Direct3D 10 device from which the OpenCL context was created. If the Direct3D 10 device is 
        deleted through the Direct3D 10 API, subsequent use of the OpenCL context will result in 
        undefined behavior, including but not limited to possible OpenCL errors, data corruption, and 
        program termination.
    </p>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
          Returns a valid non-zero OpenCL buffer
          object and <code class="varname">errcode_ret</code> is set to <span class="errorname">CL_SUCCESS</span>
          if the buffer object is created successfully. Otherwise, it returns a NULL value with
          one of the following error values returned in <code class="varname">errcode_ret</code>:
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not
              a valid context.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values specified in
              <code class="varname">flags</code> are not valid or if <code class="varname">subresource</code>
              is not a valid subresource index for <code class="varname">resource</code>.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_D3D10_RESOURCE_KHR</span> if <code class="varname">resource</code>
              is not a Direct3D 10 texture resource, if <code class="varname">resource</code>
              was created with the <code class="constant">D3D10_USAGE</code> flag
              <code class="constant">D3D10_USAGE_IMMUTABLE</code>, if a <code class="varname">resource</code>
              is a multisampled texture, if <span class="type">cl_mem</span> from subresource
              <code class="varname">subresource</code> of <code class="varname">resource</code> has already
              been created using <code class="function">clCreateFromD3D10Texture3DKHR</code>, or if
              <code class="varname">context</code> was not created against the same Direct3D 10 device
              from which <code class="varname">resource</code> was created.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if the Direct3D 10
              texture format of <code class="varname">resource</code> is not a value listed in the above
              table of Direct3D 10 and corresponding OpenCL image formats, or if the Direct3D 10
              texture format of <code class="varname">resource</code> does not map to a supported OpenCL
              image format.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
              resources required by the OpenCL implementation on the host.
            </li>
          </ul>
        </div>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p><img src="pdficon_small1.gif" />
            <a href="https://www.khronos.org/registry/cl/specs/opencl-2.0-extensions.pdf#page=73" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="cl_khr_d3d10_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d10_sharing</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2013 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
    </div>
  </body>
</html>
